{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# The Location Formatter\n", "\n", "The Location Formatter controls the format of the location to which data are saved.\n", "\n", "This notebook shows some examples of setting different location formats." ] }, { "cell_type": "code", "execution_count": 1, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Logging hadn't been started.\n", "Activating auto-logging. Current session state plus future input saved.\n", "Filename : C:\\Users\\a-halakh\\.qcodes\\logs\\command_history.log\n", "Mode : append\n", "Output logging : True\n", "Raw input log : False\n", "Timestamping : True\n", "State : active\n", "Qcodes Logfile : C:\\Users\\a-halakh\\.qcodes\\logs\\200325-3652-qcodes.log\n" ] } ], "source": [ "%matplotlib nbagg\n", "import time\n", "\n", "import matplotlib.pyplot as plt\n", "import numpy as np\n", "from qcodes.station import Station\n", "\n", "from qcodes_loop.data.location import FormatLocation\n", "from qcodes_loop.loops import Loop" ] }, { "cell_type": "code", "execution_count": 2, "metadata": {}, "outputs": [], "source": [ "# First we set up some mock experiment\n", "from qcodes.instrument_drivers.mock_instruments import DummyInstrument\n", "\n", "gates = DummyInstrument('some_gates', gates=['plunger', 'left', 'topo'])\n", "meter = DummyInstrument('meter', gates=['voltage', 'current'])\n", "\n", "station = Station(gates, meter)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## The formatter in action\n", "\n", "Now let's run some loops to get datasets and see where they end up.\n", "\n", "When writing the location format, some fields are automatically filled out.\n", "\n", "That is the fields '{date}', '{time}', and '{counter}'.\n", "All other fields must have their values provided via the record dict." ] }, { "cell_type": "code", "execution_count": 3, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Started at 2020-03-25 11:51:27\n", "DataSet:\n", " location = '2020-03-25/#003_unicorn_2020-03-25_11-51-27'\n", " | | | \n", " Setpoint | some_gates_plunger_set | plunger | (25,)\n", " Measured | meter_voltage | voltage | (25,)\n", "Finished at 2020-03-25 11:51:27\n" ] } ], "source": [ "loc_fmt='{date}/#{counter}_{name}_{date}_{time}' # set the desired location format\n", "rcd={'name': 'unicorn'} # provide a value for 'name'\n", "loc_provider = FormatLocation(fmt=loc_fmt, record=rcd) # create a location provider using that format\n", "\n", "loop = Loop(gates.plunger.sweep(0, 1, num=25), 0).each(meter.voltage)\n", "data2 = loop.run(location=loc_provider)" ] }, { "cell_type": "code", "execution_count": 4, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Started at 2020-03-25 11:51:27\n", "DataSet:\n", " location = 'my_custom_folder/#004_randomnumber_7_2020-03-25_11-51-27'\n", " | | | \n", " Setpoint | some_gates_plunger_set | plunger | (25,)\n", " Measured | meter_voltage | voltage | (25,)\n", "Finished at 2020-03-25 11:51:27\n" ] } ], "source": [ "# Now let's do that a few times with different formats\n", "\n", "import numpy as np\n", "\n", "loc_fmt='my_custom_folder/#{counter}_randomnumber_{name}_{date}_{time}'\n", "rcd = {'name': str(np.random.randint(1, 100))}\n", "loc_provider = FormatLocation(fmt=loc_fmt, record=rcd)\n", "\n", "loop = Loop(gates.plunger.sweep(0, 1, num=25), 0).each(meter.voltage)\n", "data2 = loop.run(location=loc_provider)" ] }, { "cell_type": "code", "execution_count": 5, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Started at 2020-03-25 11:51:27\n", "DataSet:\n", " location = '2020-03-25/#004_{name}_2020-03-25_hammer_time'\n", " | | | \n", " Setpoint | some_gates_plunger_set | plunger | (25,)\n", " Measured | meter_voltage | voltage | (25,)\n", "Finished at 2020-03-25 11:51:28\n" ] } ], "source": [ "# You can also overwrite the custom fields\n", "\n", "loc_fmt='{date}/#{counter}_{name}_{date}_{time}'\n", "rcd = {'time': 'hammer_time'}\n", "loc_provider = FormatLocation(fmt=loc_fmt, record=rcd)\n", "\n", "loop = Loop(gates.plunger.sweep(0, 1, num=25), 0).each(meter.voltage)\n", "data2 = loop.run(location=loc_provider)" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [] } ], "metadata": { "kernelspec": { "display_name": "qcodespip311", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.11.0 | packaged by conda-forge | (main, Jan 16 2023, 14:12:30) [MSC v.1916 64 bit (AMD64)]" }, "toc": { "base_numbering": 1, "nav_menu": {}, "number_sections": true, "sideBar": true, "skip_h1_title": false, "title_cell": "Table of Contents", "title_sidebar": "Contents", "toc_cell": false, "toc_position": {}, "toc_section_display": true, "toc_window_display": false }, "varInspector": { "cols": { "lenName": 16, "lenType": 16, "lenVar": 40 }, "kernels_config": { "python": { "delete_cmd_postfix": "", "delete_cmd_prefix": "del ", "library": "var_list.py", "varRefreshCmd": "print(var_dic_list())" }, "r": { "delete_cmd_postfix": ") ", "delete_cmd_prefix": "rm(", "library": "var_list.r", "varRefreshCmd": "cat(var_dic_list()) " } }, "types_to_exclude": [ "module", "function", "builtin_function_or_method", "instance", "_Feature" ], "window_display": false }, "vscode": { "interpreter": { "hash": "7ac3e91929df5618782934af11c3fa566d637713ed5d04bf73eff1f535fb8e06" } } }, "nbformat": 4, "nbformat_minor": 1 }